/**
  ******************************************************************************
  * @file    modbus_common.c
  * @author  ashuai0110
  * @version V2.1
  * @date    2023-10-24
  * @brief   modbus通用文件
  *
  ******************************************************************************
  * @attention
  *
  * 版权声明:内容为编者(ashuai0110)原创,使用请注明出处,当然,你也可以不这样做^_^
  * 出处链接:https://gitee.com/ashuai0110/mcu_reuse_development_module.git
  *
  ******************************************************************************
  */

/* 包含头文件-----------------------------------------------------------------*/
#include "modbus_common.h"

/**
 * @addtogroup modbus
 * @{
 */

/**
 * @defgroup modbus_common modbus_common
 * @{
 */

/* 私有宏定义-----------------------------------------------------------------*/

/* 私有类型定义---------------------------------------------------------------*/

/* 私有变量-------------------------------------------------------------------*/
/**
 * @defgroup modbus_common_local_variables modbus common local variables
 * @{
 */

/* CRC 高位字节值表 */
static const uint8_t crcHiArr[] = {
    0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0,
    0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41,
    0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0,
    0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40,
    0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1,
    0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41,
    0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1,
    0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41,
    0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0,
    0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40,
    0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1,
    0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40,
    0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0,
    0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40,
    0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0,
    0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40,
    0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0,
    0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41,
    0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0,
    0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41,
    0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0,
    0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40,
    0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1,
    0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41,
    0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0,
    0x80, 0x41, 0x00, 0xC1, 0x81, 0x40,
};
/* CRC 低位字节值表 */
static const uint8_t crcLoArr[] = {
    0x00, 0xC0, 0xC1, 0x01, 0xC3, 0x03, 0x02, 0xC2, 0xC6, 0x06,
    0x07, 0xC7, 0x05, 0xC5, 0xC4, 0x04, 0xCC, 0x0C, 0x0D, 0xCD,
    0x0F, 0xCF, 0xCE, 0x0E, 0x0A, 0xCA, 0xCB, 0x0B, 0xC9, 0x09,
    0x08, 0xC8, 0xD8, 0x18, 0x19, 0xD9, 0x1B, 0xDB, 0xDA, 0x1A,
    0x1E, 0xDE, 0xDF, 0x1F, 0xDD, 0x1D, 0x1C, 0xDC, 0x14, 0xD4,
    0xD5, 0x15, 0xD7, 0x17, 0x16, 0xD6, 0xD2, 0x12, 0x13, 0xD3,
    0x11, 0xD1, 0xD0, 0x10, 0xF0, 0x30, 0x31, 0xF1, 0x33, 0xF3,
    0xF2, 0x32, 0x36, 0xF6, 0xF7, 0x37, 0xF5, 0x35, 0x34, 0xF4,
    0x3C, 0xFC, 0xFD, 0x3D, 0xFF, 0x3F, 0x3E, 0xFE, 0xFA, 0x3A,
    0x3B, 0xFB, 0x39, 0xF9, 0xF8, 0x38, 0x28, 0xE8, 0xE9, 0x29,
    0xEB, 0x2B, 0x2A, 0xEA, 0xEE, 0x2E, 0x2F, 0xEF, 0x2D, 0xED,
    0xEC, 0x2C, 0xE4, 0x24, 0x25, 0xE5, 0x27, 0xE7, 0xE6, 0x26,
    0x22, 0xE2, 0xE3, 0x23, 0xE1, 0x21, 0x20, 0xE0, 0xA0, 0x60,
    0x61, 0xA1, 0x63, 0xA3, 0xA2, 0x62, 0x66, 0xA6, 0xA7, 0x67,
    0xA5, 0x65, 0x64, 0xA4, 0x6C, 0xAC, 0xAD, 0x6D, 0xAF, 0x6F,
    0x6E, 0xAE, 0xAA, 0x6A, 0x6B, 0xAB, 0x69, 0xA9, 0xA8, 0x68,
    0x78, 0xB8, 0xB9, 0x79, 0xBB, 0x7B, 0x7A, 0xBA, 0xBE, 0x7E,
    0x7F, 0xBF, 0x7D, 0xBD, 0xBC, 0x7C, 0xB4, 0x74, 0x75, 0xB5,
    0x77, 0xB7, 0xB6, 0x76, 0x72, 0xB2, 0xB3, 0x73, 0xB1, 0x71,
    0x70, 0xB0, 0x50, 0x90, 0x91, 0x51, 0x93, 0x53, 0x52, 0x92,
    0x96, 0x56, 0x57, 0x97, 0x55, 0x95, 0x94, 0x54, 0x9C, 0x5C,
    0x5D, 0x9D, 0x5F, 0x9F, 0x9E, 0x5E, 0x5A, 0x9A, 0x9B, 0x5B,
    0x99, 0x59, 0x58, 0x98, 0x88, 0x48, 0x49, 0x89, 0x4B, 0x8B,
    0x8A, 0x4A, 0x4E, 0x8E, 0x8F, 0x4F, 0x8D, 0x4D, 0x4C, 0x8C,
    0x44, 0x84, 0x85, 0x45, 0x87, 0x47, 0x46, 0x86, 0x82, 0x42,
    0x43, 0x83, 0x41, 0x81, 0x80, 0x40,
};

/* HEX转ASCII */
static const char HEX_TO_ASCII[] = {0x30,0x31,0x32,0x33,0x34,0x35,0x36,0x37,0x38,0x39,0X41,0X42,0X43,0X44,0X45,0X46};

/**
 * @}
 */

/* 全局变量-------------------------------------------------------------------*/

/* 私有函数原型---------------------------------------------------------------*/
/**
 * @defgroup modbus_common_global_functions modbus common global functions
 * @{
 */

/**
  * @brief  CRC16校验(MODBUS)
  *
  * @param  pBuf : 校验数据
  *
  * @param  len  : 校验数据长度
  *
  * @retval 校验结果
  */
uint16_t mb_check_crc16(uint8_t *pBuf, uint16_t len)
{
    uint8_t crcHi = 0xFF; /* 高CRC字节初始化 */
    uint8_t crcLo = 0xFF; /* 低CRC 字节初始化 */
    uint16_t index;  /* CRC循环中的索引 */

    while(len--)
    {
        index = crcHi ^ *pBuf++; /* 计算CRC */
        crcHi = crcLo ^ crcHiArr[index];
        crcLo = crcLoArr[index];
    }
    
    return ((uint16_t)crcHi << 8 | crcLo);
}

/**
  * @brief  LRC校验
  *
  * @param  pBuf : 校验数据
  *
  * @param  len  : 校验数据长度
  *
  * @retval 校验结果
  */
uint8_t mb_check_lrc(uint8_t *pBuf, uint16_t len)
{
    uint8_t lrc = 0;
    
    for(uint16_t index = 0; index < len; index++)
    {
        lrc += pBuf[index];
    }
    
    lrc = (~lrc) + 1;
    
    return lrc;
}

/**
  * @brief  HEX转ASCII
  *
  * @param  pHex   : hex数据缓存区
  *
  * @param  num    : hex数据数量
  *
  * @param  pAscii : ascii数据存储区
  *
  * @retval None
  */
void mb_hex_to_ascii(uint8_t *pHex, uint16_t num, uint8_t *pAscii)
{
    /* 从后往前转换 */
    for(int16_t index = num - 1; index >= 0; index--)
    {
        pAscii[(index << 1) + 1] = HEX_TO_ASCII[pHex[index] >> 4];
        pAscii[(index << 1) + 2] = HEX_TO_ASCII[pHex[index] & 0xF];
    }
}

/**
  * @brief  ASCII转HEX
  *
  * @param  pAscii : ascii数据缓存区
  *
  * @param  num    : ascii数据数量
  *
  * @param  pHex   : hex数据存储区
  *
  * @retval None
  */
void mb_ascii_to_hex(uint8_t *pAscii, uint16_t num, uint8_t *pHex)
{
    uint8_t index1, index2;
    /* 从前往后转换 */
    for(uint8_t i = 0; i < (num >> 1); i++)
    {
        index1 = i << 1;
        index2 = index1 + 1;
        pHex[i] = ((pAscii[index1] > '9' ? (pAscii[index1] + 0x9) : pAscii[index1]) << 4) | ((pAscii[index2] > '9' ? (pAscii[index2] + 0x9) : pAscii[index2]) & 0xF);
    }
}

/**
  * @brief  设置对应位(一般用于线圈和离散量)
  *
  * @param  srcBuf    : 源数据地址
  *
  * @param  bitOffset : 位偏移量
  *
  * @param  bitNum    : 位数量
  *
  * @param  bitVal    : 位数据
  *
  * @retval None
  */
void mb_set_bits(uint8_t *srcBuf, uint16_t bitOffset, uint8_t bitNum, uint8_t bitVal)
{
    uint8_t byteOffset;
    uint8_t preBitNum;
    uint16_t bitMask;
    uint16_t bitValTmp;
    
    byteOffset = bitOffset / 8; /* 数据索引 */
    preBitNum = bitOffset % 8; /* bit开始的位数 */
    bitMask = ((1 << bitNum) - 1) << preBitNum; /* 掩码位 */
    bitValTmp = bitVal << preBitNum;  /* 数据偏移后 */
    
    *(uint16_t *)&srcBuf[byteOffset] = (*(uint16_t *)&srcBuf[byteOffset] & (~bitMask)) | bitValTmp; /* 修改对应位 */
}

/**
  * @brief  获取对应位(一般用于线圈和离散量)
  *
  * @param  srcBuf    : 源数据地址
  *
  * @param  bitOffset : 位偏移量
  *
  * @param  bitNum    : 位数量
  *
  * @retval 返回对应位
  */
uint8_t mb_get_bits(uint8_t *srcBuf, uint16_t bitOffset, uint8_t bitNum)
{
    uint8_t byteOffset;
    uint8_t preBitNum;
    uint8_t bitMask;
    uint8_t retVal;
    
    byteOffset = bitOffset / 8; /* 数据索引 */
    preBitNum = bitOffset % 8; /* bit开始的位数 */
    bitMask = (1 << bitNum) - 1; /* 掩码位 */
    
    retVal = *(uint16_t *)&srcBuf[byteOffset] >> preBitNum; /* 获取对应位 */
    retVal = retVal & bitMask; /* 保留有效位 */
    
    return retVal;
}

/**
 * @}
 */

/**
 * @}
 */

/**
 * @}
 */

